Last Update: 2025/3/26

SenseFlow App APIs

The SenseFlow App APIs are designed to provide a seamless integration between SenseFlow and your LLM provider.

Endpoints

Get App Info

GET https://platform.llmprovider.ai/v1/agent/info

Retrieve basic application information.

Request Headers

Header	Value
Authorization	Bearer YOUR_API_KEY
Content-Type	application/json

Request Param

Field	Type	Description
model	string	agent name

Response

Field	Type	Description
name	string	App name
description	string	App description
tags	array[string]	App tags

Example Response

{
  "name": "SenseFlow Assistant",
  "description": "A general-purpose AI assistant",
  "tags": [
    "chat",
    "completion",
    "multimodal"
  ]
}

Example Request

Shell

curl -X GET 'https://platform.llmprovider.ai/v1/agent/info' \
--header 'Authorization: Bearer $YOUR_API_KEY'

Python

import requests

api_key = 'YOUR_API_KEY'
url = 'https://platform.llmprovider.ai/v1/agent/info'

headers = {
    'Authorization': f'Bearer {api_key}'
}

response = requests.get(url, headers=headers)
print(response.json())

Node.js

const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const url = 'https://platform.llmprovider.ai/v1/agent/info';

const headers = {
    'Authorization': `Bearer ${apiKey}`
};

axios.get(url, {headers})
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

Get Parameters

GET https://platform.llmprovider.ai/v1/agent/parameters

Retrieve application parameters including feature flags, input parameters, and system settings.

Request Headers

Header	Value
Authorization	Bearer YOUR_API_KEY
Content-Type	application/json

Request Param

Field	Type	Description
model	string	agent name

Response

Parameter	Type	Description
opening_statement	string	Welcome message
suggested_questions	array	Initial suggested questions
speech_to_text	object	Speech-to-text settings
retriever_resource	object	Citation and attribution settings
user_input_form	array	Input form configuration
file_upload	object	File upload settings
system_parameters	object	System-wide parameters

Example Response

{
  "introduction": "nice to meet you",
  "user_input_form": [
    {
      "text-input": {
        "label": "a",
        "variable": "a",
        "required": true,
        "max_length": 48,
        "default": ""
      }
    }
  ],
  "file_upload": {
    "image": {
      "enabled": true,
      "number_limits": 3,
      "transfer_methods": [
        "remote_url",
        "local_file"
      ]
    }
  },
  "system_parameters": {
    "file_size_limit": 15,
    "image_file_size_limit": 10,
    "audio_file_size_limit": 50,
    "video_file_size_limit": 100
  }
}

Example Request

Shell

curl -X GET 'https://platform.llmprovider.ai/v1/agent/parameters' \
--header 'Authorization: Bearer $YOUR_API_KEY'

Python

import requests

api_key = 'YOUR_API_KEY'
url = 'https://platform.llmprovider.ai/v1/agent/parameters'

headers = {
    'Authorization': f'Bearer {api_key}'
}

response = requests.get(url, headers=headers)
print(response.json())

Node.js

const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const url = 'https://platform.llmprovider.ai/v1/agent/parameters';

const headers = {
    'Authorization': `Bearer ${apiKey}`
};

axios.get(url, {headers})
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

For more detailed information about using these endpoints, please refer to our API Documentation.

Get Meta

GET https://platform.llmprovider.ai/v1/agent/meta

Retrieve application meta information including tool icons.

Request Headers

Header	Value
Authorization	Bearer YOUR_API_KEY
Content-Type	application/json

Request Param

Field	Type	Description
model	string	agent name

Response

Parameter	Type	Description
tool_icons	object[string]	Tool icon configurations

The tool_icons object contains:

Field	Type	Description
tool_name	string	Name of the tool
icon	object/string	Icon configuration or URL

For object type icons:

Field	Type	Description
background	string	Hex color code for background
content	string	Emoji icon content

Example Response

{
  "tool_icons": {
    "dalle2": "https://example.com/dalle2.png",
    "api_tool": {
      "background": "#252525",
      "content": "😁"
    }
  }
}

Example Request

Shell

curl -X GET 'https://platform.llmprovider.ai/v1/agent/meta' \
--header 'Authorization: Bearer $YOUR_API_KEY'

Python

import requests

api_key = 'YOUR_API_KEY'
url = 'https://platform.llmprovider.ai/v1/agent/meta'

headers = {
        'Authorization': f'Bearer {api_key}'
}

response = requests.get(url, headers=headers)
print(response.json())

Node.js

const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const url = 'https://platform.llmprovider.ai/v1/agent/meta';

const headers = {
    'Authorization': `Bearer ${apiKey}`
};

axios.get(url, {headers})
    .then(response => console.log(response.data))
    .catch(error => console.error(error));